schm-nccs-cip-eapi

1.0.x
(0 reviews)

API Reference (Chinese Version)

schm-nccs-cip-eapi

接口描述: 本地文件上传&合规性校验接口，可支持多文件合规性校验后上传（目前只支持图片类型文件进行合规性校验），非图片类型文件不会进行合规性校验，会直接上传合规目录。
DEV地址（开发环境）: https://schm-api-dev.shiseido.cn/schm-nccs-cip-eapi
UAT地址（测试环境）: https://schm-api-test.shiseido.cn/schm-nccs-cip-eapi
PROD地址（生产环境）: https://schm-api.shiseido.cn/schm-nccs-cip-eapi

1.身份认证

所有请求头必须包含以下键值参数作为身份验证信息。您需要向管理员申请这些信息。

client_id: fa98****3452
client_secret: 108b****41f2

2.接口总览:

请求接口描述
/upload本地文件上传&合规性校验接口，可支持多文件合规性校验后上传（目前只支持图片类型文件进行合规性校验），非图片类型文件不会进行合规性校验，会直接上传合规目录。

完整调用地址为对应环境地址+接口地址，例如：

https://schm-api-test.shiseido.cn/schm-nccs-cip-eapi/upload

3.接口调用说明

3.1 文件上传&审核接口

请求接口: /upload
接口描述: 本地文件上传&合规性校验接口，可支持多文件合规性校验后上传（目前只支持图片类型文件进行合规性校验），非图片类型文件不会进行合规性校验，会直接上传合规目录。
请求类型: HTTP POST

3.2 参数说明

body类型: multipart/form-data

字段描述字段名称类型长度必填备注
文件filefile是支持多文件上传，都传入一个file参数中，无需定义多个file参数

3.2 参数示例

resources/image-f6681ba8-7d51-4bb5-a2c9-bacedbb1a636.png

3.3 返回值说明

字段描述字段名称类型必填备注
响应状态statusString是"success" 表示成功
上传结果信息resultArray是包含文件上传&审核信息

上传结果信息 result:

字段描述字段名称类型长度是否必填备注
提示消息msgString是success-文件检验成功,以及错误提示信息
文件名file_nameString是
风险等级risk_levelString否none-无风险，目前只支持图片校验风险违规，其他类型文件该值为null
风险信息infoArray否目前只支持图片校验风险违规，其他类型文件该值为null
是否合规passString是true-合规，false-不合规
oss的桶bucketString是
文件路径bucket_pathString是上传到的oss路径
oss文件上传到的目的地oss_destinationString是

风险信息 info:

字段描述字段名称类型长度是否必填备注
风险值confidenceString否1~100，分值越大，风险越高，无风险该值为null，系统默认超过50分为违规文件
涉及违规内容labelString是如：political_politicalFigure，涉及政治人物，无风险该值为nonLabel

3.4 返回值示例

{
    "status": "success",
    "result": [
        {
                  "msg": "success",
            "file_name": "oss信息.txt",
            "risk_level": null,
            "info": null,
            "pass": true,
            "bucket": "jobcenter",
            "bucket_path": "WMS/SAP/Xuhe/oss信息.txt",
            "oss_destination": "https://schm-api-dev.shiseido.cn/schm-oss-processing-sapi/object/view?oss=jobcenter&path=WMS/SAP/Xuhe/oss信息.txt"
        },
        {
                "msg": "success",
            "file_name": "让人.png",
            "risk_level": "high",
            "info": [
                {
                    "confidence": 97.9000015258789,
                    "label": "political_politicalFigure"
                },
                {
                    "confidence": 86.11000061035156,
                    "label": "political_historicalNihility"
                }
            ],
            "pass": false,
            "bucket": "jobcenter",
            "bucket_path": "WMS/SAP/unknow/让人.png",
            "oss_destination": "https://schm-api-dev.shiseido.cn/schm-oss-processing-sapi/object/view?oss=jobcenter&path=WMS/SAP/unknow/让人.png"
        }
    ]
}

Reviews